Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature/merge time series schemas #1127

Merged
merged 52 commits into from
Aug 16, 2024
Merged

Feature/merge time series schemas #1127

merged 52 commits into from
Aug 16, 2024

Conversation

Flix6x
Copy link
Contributor

@Flix6x Flix6x commented Jul 20, 2024 •
edited
Loading

Description

  • Merge two core schemata used to specify time series data in a flex model, namely QuantityOrSensor and TimeSeriesOrSensor.
  • Named new schema VariableQuantityField.
  • Backward compatibility: deprecate old schemas, but keep them functioning for now (while logging a deprecation warning).
  • Allow setting a SoC unit directly in some fields (formerly Float fields, and now Quantity fields), while still falling back on the contents of the soc-unit field, for backwards compatibility:
    • soc-at-start
    • soc-min
    • soc-max
  • Allow setting a unit directly in fields that already supported passing a time series:
    • soc-maxima
    • soc-minima
    • soc-targets
  • Allow passing a time series in fields that formerly only accepted passing a fixed quantity or a sensor reference:
    • power-capacity
    • consumption-capacity
    • production-capacity
    • charging-efficiency
    • discharging-efficiency
    • storage-efficiency
    • soc-gain
    • soc-usage
  • Revise docs in flex-model-v2g.rst with regards to passing dynamic power constraints as part of the flex-model
  • Remove all but one mention of the soc-unit field from the docs (still works under the hood)
  • Add test cases for passing a time series to the new schema

Look & Feel

Synchronizes support for specifying time series data in a flex model in three distinct ways:

  • As a constant quantity, such as: 
    "10 kW"
  • As a time series, such as (NB the below example assumes the unit is specified via a separate field): 
    [
    {
        "value": 51,
        "start": "2024-02-04T10:35:00+01:00",
        "end": "2024-02-05T04:25:00+01:00"
    }
]
  • As a sensor, such as: 
    {
    "sensor": 101
}

How to test

See https://github.com/FlexMeasures/flexmeasures/pull/1127/files#diff-1f68bebf4090d2608b43200311d3ebd3e0ad637e2e16cc6a9b14bffaa29757f3R2177

Further Improvements

Related Items

Flix6x added 16 commits July 19, 2024 00:21
@Flix6x
refactor: sync arg name
902d95f 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: sync internal property name
6e868d8 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: flatten elif block
d8b2499 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: allow string deserialization and allow setting a default so…
77de0df 
…urce unit for interpreting values without a unit

Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: copy convert method
8c9fe3f 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
fix: type annotation
ef0d5e8 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: copy _serialize method
a9364b1 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: adapt _serialize method
b3070f7 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: adapt docstring
1339b1a 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: update error message
5107026 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: update type annotation
9084e53 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: merge schemas
bb157cf 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: reduce number of blank lines
ba8e1cc 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
fix: deprecate old classes
392a118 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
fix: duplicate import
258520e 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: document status quo
1475776 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x self-assigned this Jul 20, 2024
Flix6x added 11 commits July 20, 2024 23:24
@Flix6x
style: black
5cecd86 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
style: flake8
dbb91a8 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
feature: allow interpreting float values as quantities based on a uni…
9478c5a 
…t defined elsewhere, and specifically, let the StorageScheduler get its default SoC unit from the soc-unit field, which lets us allow time series values to be specified as string quantities while preserving backwards compatibility

Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
fix: maintain backwards compatibility for transforming Float fields i…
ba26a2e 
…nto Quantity fields, by returning the magnitude upon deserialization

Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: grammar
ead17b8 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: add todo
c847870 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
fix: tests
137f6ae 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
style: black
00bf425 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: update V2G flex-model
cc68ccf 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: update trigger endpoint examples
b29dad2 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: update other tutorials
ee10c19 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: rename new schema
ab30487 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: sync code order: 1) Sensor, 2) time series, 3) Quantity
8d17a92 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
Merge remote-tracking branch 'refs/remotes/origin/main' into feature/…
7cca59e 
…merge-time-series-schemas
@Flix6x Flix6x mentioned this pull request Aug 6, 2024
Open
@Flix6x Flix6x added this to the 0.23.0 milestone Aug 7, 2024
@nhoening
Copy link
Contributor

nhoening commented Aug 7, 2024

In #1128 we also mentioned that:

If this PR is the successor, then it should also take those promises over. They might be rather meaningful for users.

@Flix6x
fix: add test and add missing logic for handling a list of dictionari…
161f314 
…es representing a time series

Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
fix: check for real numeric values
03bac84 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x mentioned this pull request Aug 9, 2024
Open
@Flix6x
Copy link
Contributor Author

Flix6x commented Aug 9, 2024

  • we'd add examples (of scheduling non-MW sensors) to the documentation

Moved to #1139

@Flix6x
Merge remote-tracking branch 'refs/remotes/origin/main' into feature/…
1b7fa03 
…merge-time-series-schemas
@Flix6x
docs: changelog entries
1ffc335 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: fix typo
8ccc6f6 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
style: be more explicit about requiring the soc-unit field to be set
1a430c0 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x mentioned this pull request Aug 9, 2024
Merged
victorgarcia98
victorgarcia98 requested changes Aug 14, 2024
View reviewed changes
documentation/changelog.rst Outdated Show resolved Hide resolved
documentation/features/scheduling.rst Show resolved Hide resolved
flexmeasures/cli/data_add.py Show resolved Hide resolved
flexmeasures/data/models/planning/storage.py Outdated Show resolved Hide resolved
flexmeasures/data/models/planning/storage.py Outdated Show resolved Hide resolved
flexmeasures/data/models/planning/tests/test_solver.py Show resolved Hide resolved
flexmeasures/data/schemas/sensors.py Show resolved Hide resolved
@Flix6x
docs: mention the new Marshmallow field
8ec14c5 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: advise setting a unit per field explicitly
8fd4ec1 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: simplify if statement
15e19dc 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: move soc-unit guesswork into schema
8c233ca 
Signed-off-by: F.N. Claessen <felix@seita.nl>
victorgarcia98
victorgarcia98 approved these changes Aug 16, 2024
View reviewed changes
Copy link
Contributor

@victorgarcia98 victorgarcia98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@Flix6x
Merge branch 'main' into feature/merge-time-series-schemas
ba20453 
Signed-off-by: Felix Claessen <30658763+Flix6x@users.noreply.github.com>
@Flix6x Flix6x merged commit a128275 into main Aug 16, 2024
7 checks passed
@Flix6x Flix6x deleted the feature/merge-time-series-schemas branch August 16, 2024 15:40
@nhoening nhoening mentioned this pull request Sep 18, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@victorgarcia98 victorgarcia98 victorgarcia98 approved these changes

Assignees

@Flix6x Flix6x

Labels
API Scheduling
Projects
None yet
Milestone
0.23.0
Development

Successfully merging this pull request may close these issues.

Send dynamic powerconstraint in flex-model Schedule non-MW sensors
3 participants
@Flix6x @nhoening @victorgarcia98